<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
                      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
    <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
    <title>Recomenda&ccedil;&otilde;es - Zend Framework Manual</title>

    <link href="../css/shCore.css" rel="stylesheet" type="text/css" />
    <link href="../css/shThemeDefault.css" rel="stylesheet" type="text/css" />
    <link href="../css/styles.css" media="all" rel="stylesheet" type="text/css" />
</head>
<body>
<h1>Zend Framework</h1>
<h2>Programmer's Reference Guide</h2>
<ul>
    <li><a href="../en/doc-standard.recommendations.html">Inglês (English)</a></li>
    <li><a href="../pt-br/doc-standard.recommendations.html">Português Brasileiro (Brazilian Portuguese)</a></li>
</ul>
<table width="100%">
    <tr valign="top">
        <td width="85%">
            <table width="100%">
                <tr>
                    <td width="25%" style="text-align: left;">
                    <a href="doc-standard.file-formatting.html">Formata&ccedil;&atilde;o dos Arquivos de Documenta&ccedil;&atilde;o</a>
                    </td>

                    <td width="50%" style="text-align: center;">
                        <div class="up"><span class="up"><a href="doc-standard.html">Norma sobre a documenta&ccedil;&atilde;o do Zend Framework</a></span><br />
                        <span class="home"><a href="manual.html">Guia de Refer&ecirc;ncia do Programador</a></span></div>
                    </td>

                    <td width="25%" style="text-align: right;">
                        <div class="next" style="text-align: right; float: right;"><a href="project-structure.html">Recommended Project Structure for Zend Framework MVC Applications</a></div>
                    </td>
                </tr>
            </table>
<hr />
<div id="doc-standard.recommendations" class="section"><div class="info"><h1 class="title">Recomendações</h1></div>
        

        <div class="section" id="doc-standard.recommendations.editors"><div class="info"><h1 class="title">Use editores sem formatação automática</h1></div>
            

            <p class="para">
                Para editar a documentação, normalmente você não deve usar os editores
                <acronym class="acronym">XML</acronym> clássicos. Esses editores geralmente formatam automaticamente
                os documentos existentes para que se adaptem as suas próprias normas e/ou não seguem
                rigorosamente o padrão docbook. Como exemplos, já os vimos apagar as tags
                <acronym class="acronym">CDATA</acronym>, substituírem 4 espaços por tabs ou 2 espaços etc.
            </p>

            <p class="para">
                Estas diretrizes foram escritas em grande parte para auxiliar os tradutores no
                reconhecimento das linhas que foram alteradas usando as ferramentas de
                <strong class="command">diff</strong> normais. A formatação automática torna esse processo mais
                difícil.
            </p>
        </div>

        <div class="section" id="doc-standard.recommendations.images"><div class="info"><h1 class="title">Use Imagens</h1></div>
            

            <p class="para">
                Boas imagens e diagramas podem melhorar a legibilidade e a compreensão. Use-as
                sempre que ajudarem nesses objetivos. Imagens devem ser colocadas no diretório
                <var class="filename">documentation/manual/en/figures/</var>, e nomeadas após o
                identificador de seção em que lhes diz respeito.
            </p>
        </div>

        <div class="section" id="doc-standard.recommendations.examples"><div class="info"><h1 class="title">Use Exemplos de Caso de Uso</h1></div>
            

            <p class="para">
                Procure por bons casos de uso apresentados pela comunidade, especialmente aqueles
                que são publicados nos comentários de sugestão ou nas listas de discussão. Os
                exemplos frequentemente ilustram a utilização muito melhor do que todo o texto.
            </p>

            <p class="para">
                Ao escrever seus exemplos para inclusão no manual, siga todas as normas de
                codificação e de documentação.
            </p>
        </div>

        <div class="section" id="doc-standard.recommendations.phpdoc"><div class="info"><h1 class="title">Evite Duplicar o Conteúdo de phpdoc</h1></div>
            

            <p class="para">
                O manual pretende ser um guia de referência para a utilização do usuário final. A
                duplicação da documentação de phpdoc para componentes e classes de uso interno não é
                desejada, e a documentação deve estar focada na utilização e não no funcionamento
                interno. Em qualquer caso, neste momento, gostaríamos que as equipes de documentação
                se concentrassem na tradução do manual em inglês, e não nos comentários de phpdoc.
            </p>
        </div>

        <div class="section" id="doc-standard.recommendations.links"><div class="info"><h1 class="title">Use Links</h1></div>
            

            <p class="para">
                Crie links para outras seções do manual ou para fontes externas em vez de recriar
                documentação.
            </p>

            <p class="para">
                Os links para outras seções do manual podem ser feitos usando o elemento
                <em class="emphasis">&lt;link&gt;</em> (para o qual você deve fornecer o nome do link).
            </p>

            <pre class="programlisting brush: xml">
&lt;para&gt;
    &quot;Link&quot; cria um link para uma seção, usando um texto descritivo: &lt;link
        linkend=&quot;doc-standard.recommendations.links&quot;&gt;documentação sobre os
        links&lt;/link&gt;.
&lt;/para&gt;
</pre>


            <p class="para">
                Para criar um link para uma fonte externa, use <em class="emphasis">&lt;ulink&gt;</em>:
            </p>

            <pre class="programlisting brush: xml">
&lt;para&gt;
    O &lt;ulink url=&quot;http://framework.zend.com/&quot;&gt;site do Zend Framework&lt;/ulink&gt;.
&lt;/para&gt;
</pre>

        </div>
    </div>
        <hr />

            <table width="100%">
                <tr>
                    <td width="25%" style="text-align: left;">
                    <a href="doc-standard.file-formatting.html">Formata&ccedil;&atilde;o dos Arquivos de Documenta&ccedil;&atilde;o</a>
                    </td>

                    <td width="50%" style="text-align: center;">
                        <div class="up"><span class="up"><a href="doc-standard.html">Norma sobre a documenta&ccedil;&atilde;o do Zend Framework</a></span><br />
                        <span class="home"><a href="manual.html">Guia de Refer&ecirc;ncia do Programador</a></span></div>
                    </td>

                    <td width="25%" style="text-align: right;">
                        <div class="next" style="text-align: right; float: right;"><a href="project-structure.html">Recommended Project Structure for Zend Framework MVC Applications</a></div>
                    </td>
                </tr>
            </table>
</td>
        <td style="font-size: smaller;" width="15%"> <style type="text/css">
#leftbar {
	float: left;
	width: 186px;
	padding: 5px;
	font-size: smaller;
}
ul.toc {
	margin: 0px 5px 5px 5px;
	padding: 0px;
}
ul.toc li {
	font-size: 85%;
	margin: 1px 0 1px 1px;
	padding: 1px 0 1px 11px;
	list-style-type: none;
	background-repeat: no-repeat;
	background-position: center left;
}
ul.toc li.header {
	font-size: 115%;
	padding: 5px 0px 5px 11px;
	border-bottom: 1px solid #cccccc;
	margin-bottom: 5px;
}
ul.toc li.active {
	font-weight: bold;
}
ul.toc li a {
	text-decoration: none;
}
ul.toc li a:hover {
	text-decoration: underline;
}
</style>
 <ul class="toc">
  <li class="header home"><a href="manual.html">Guia de Refer&ecirc;ncia do Programador</a></li>
  <li class="header up"><a href="manual.html">Guia de Refer&ecirc;ncia do Programador</a></li>
  <li class="header up"><a href="doc-standard.html">Norma sobre a documenta&ccedil;&atilde;o do Zend Framework</a></li>
  <li><a href="doc-standard.overview.html">Vis&atilde;o Geral</a></li>
  <li><a href="doc-standard.file-formatting.html">Formata&ccedil;&atilde;o dos Arquivos de Documenta&ccedil;&atilde;o</a></li>
  <li class="active"><a href="doc-standard.recommendations.html">Recomenda&ccedil;&otilde;es</a></li>
 </ul>
 </td>
    </tr>
</table>

<script type="text/javascript" src="../js/shCore.js"></script>
<script type="text/javascript" src="../js/shAutoloader.js"></script>
<script type="text/javascript" src="../js/main.js"></script>

</body>
</html>